PrintVisitor.java

/*
 *  Author:  Chris Seguin
 *
 *  This software has been developed under the copyleft
 *  rules of the GNU General Public License.  Please
 *  consult the GNU General Public License for more
 *  details about use and distribution of this software.
 */
package org.acm.seguin.summary;

import java.util.Iterator;

/**
 *  Print all the summaries
 *
 *@author     Chris Seguin
 *@created    May 15, 1999
 */
public class PrintVisitor extends TraversalVisitor {
	/**
	 *  Visit a summary node. This is the default method.
	 *
	 *@param  node  the summary that we are visiting
	 *@param  data  the data that was passed in
	 *@return       the result
	 */
	public Object visit(Summary node, Object data) {
		//  Shouldn't have to do anything about one of these nodes
		return data;
	}


	/**
	 *  Visit a package summary.
	 *
	 *@param  node  the summary that we are visiting
	 *@param  data  the data that was passed in
	 *@return       the result
	 */
	public Object visit(PackageSummary node, Object data) {
		//  Print the message
		String indent = (String) data;
		System.out.println(indent + "Package:  " + node.getName());

		//  Traverse the children
		super.visit(node, indent + "  ");

		//  Doesn't change
		return data;
	}


	/**
	 *  Visit a file summary.
	 *
	 *@param  node  the summary that we are visiting
	 *@param  data  the data that was passed in
	 *@return       the result
	 */
	public Object visit(FileSummary node, Object data) {
		if (node.getFile() == null) {
			return data;
		}

		//  Print the message
		String indent = (String) data;
		System.out.println(indent + "File:  " + node.getName());

		//  Traverse the children
		super.visit(node, indent + "  ");

		//  Doesn't change
		return data;
	}


	/**
	 *  Visit a import summary.
	 *
	 *@param  node  the summary that we are visiting
	 *@param  data  the data that was passed in
	 *@return       the result
	 */
	public Object visit(ImportSummary node, Object data) {
		//  Print the message
		String indent = (String) data;
		String type = node.getType();

		//  Print what we have loaded
		System.out.print(indent + "Import:  " + node.getPackage().getName());
		if (type == null) {
			System.out.println("  *");
		}
		else {
			System.out.println("  " + type);
		}

		//  Doesn't change
		return data;
	}


	/**
	 *  Visit a type summary.
	 *
	 *@param  node  the summary that we are visiting
	 *@param  data  the data that was passed in
	 *@return       the result
	 */
	public Object visit(TypeSummary node, Object data) {
		//  Local Variables
		String prefix;

		//  Print the message
		String indent = (String) data;
		if (node.isInterface()) {
			System.out.println(indent + "Interface:  " + node.getName());
			prefix = indent + "  Extends:  ";
		}
		else {
			System.out.println(indent + "Class:  " + node.getName());
			Summary parentClass = node.getParentClass();
			if (parentClass != null) {
				System.out.println(indent + "  Extends:  " + parentClass.toString());
			}
			prefix = indent + "  Implements:  ";
		}

		//  The iterator over interfaces
		Iterator iter = node.getImplementedInterfaces();
		if (iter != null) {
			while (iter.hasNext()) {
				TypeDeclSummary next = (TypeDeclSummary) iter.next();
				System.out.println(prefix + next.toString());
			}
		}

		//  Traverse the children
		super.visit(node, indent + "  ");

		//  Doesn't change
		return data;
	}


	/**
	 *  Visit a method summary.
	 *
	 *@param  node  the summary that we are visiting
	 *@param  data  the data that was passed in
	 *@return       the result
	 */
	public Object visit(MethodSummary node, Object data) {
		//  Local Variables
		String prefix;

		//  Print the message
		String indent = (String) data;
		System.out.println(indent + "Method:  " + node.getName());
		prefix = indent + "  Depends:  ";

		//  The iterator over dependencies
		Iterator iter = node.getDependencies();
		if (iter != null) {
			while (iter.hasNext()) {
				Summary next = (Summary) iter.next();
				System.out.println(prefix + next.toString());
			}
		}

		//  Doesn't change
		return data;
	}


	/**
	 *  Visit a field summary.
	 *
	 *@param  node  the summary that we are visiting
	 *@param  data  the data that was passed in
	 *@return       the result
	 */
	public Object visit(FieldSummary node, Object data) {
		//  Print the message
		String indent = (String) data;
		System.out.println(indent + "Field:  " + node.getName());

		//  Doesn't change
		return data;
	}


	/**
	 *  Visit a parameter summary.
	 *
	 *@param  node  the summary that we are visiting
	 *@param  data  the data that was passed in
	 *@return       the result
	 */
	public Object visit(ParameterSummary node, Object data) {
		return data;
	}


	/**
	 *  Visit a local variable summary.
	 *
	 *@param  node  the summary that we are visiting
	 *@param  data  the data that was passed in
	 *@return       the result
	 */
	public Object visit(LocalVariableSummary node, Object data) {
		return data;
	}


	/**
	 *  Visit a variable summary.
	 *
	 *@param  node  the summary that we are visiting
	 *@param  data  the data that was passed in
	 *@return       the result
	 */
	public Object visit(VariableSummary node, Object data) {
		return data;
	}


	/**
	 *  Visit a type declaration summary.
	 *
	 *@param  node  the summary that we are visiting
	 *@param  data  the data that was passed in
	 *@return       the result
	 */
	public Object visit(TypeDeclSummary node, Object data) {
		return data;
	}


	/**
	 *  Visit a message send summary.
	 *
	 *@param  node  the summary that we are visiting
	 *@param  data  the data that was passed in
	 *@return       the result
	 */
	public Object visit(MessageSendSummary node, Object data) {
		return data;
	}


	/**
	 *  Visit a field access summary.
	 *
	 *@param  node  the summary that we are visiting
	 *@param  data  the data that was passed in
	 *@return       the result
	 */
	public Object visit(FieldAccessSummary node, Object data) {
		return data;
	}
}